Skip to content

Quote SEARCH string args, fix LARGER/SMALLER, UTF-8 SEARCH#117

Draft
mpscholten wants to merge 3 commits into
qnikst:masterfrom
mpscholten:codex/imap-search-correctness
Draft

Quote SEARCH string args, fix LARGER/SMALLER, UTF-8 SEARCH#117
mpscholten wants to merge 3 commits into
qnikst:masterfrom
mpscholten:codex/imap-search-correctness

Conversation

@mpscholten

Copy link
Copy Markdown
Contributor

Stacked on #116#115. Part of the series bringing the belege.ai fork's IMAP fixes upstream. The diff shows the UIDPLUS (#115) and case-insensitive (#116) commits too until those merge; the commit that belongs to this PR is "Quote SEARCH string args, fix LARGER/SMALLER, add UTF-8 SEARCH". Merge order: #115#116 → this.

What

Three SEARCH-command correctness fixes:

  1. Quote string arguments. BCC/BODY/CC/FROM/HEADER/SUBJECT/TEXT/TO/X-GM-RAW were interpolated unquoted, so any value with a space or special character produced a malformed command (e.g. SUBJECT hello world → server sees two tokens). They're now wrapped with quoteIMAPString.
  2. Fix LARGER/SMALLER. They wrapped the octet count in {} — the literal syntax — emitting LARGER {100}. The argument is a plain number: LARGER 100.
  3. UTF-8 SEARCH. When a query contains non-ASCII text, SEARCH now prepends CHARSET UTF-8 (RFC 3501 §6.4.4) and the command is sent UTF-8 encoded (sendCommandNoResponse), instead of being truncated to Latin-1 by BS.pack.

Tests

New imapSearchApiTest: quoting of string args, brace-free LARGER/SMALLER, charset omitted for ASCII, CHARSET UTF-8 added for non-ASCII.

Same single pre-existing master failure (append preserves raw crlf message bytes) as the rest of the series; untouched here.

🤖 Generated with Claude Code

Adds UIDPLUS extension support so callers can recover the UIDs the
server assigns on APPEND/COPY and target expunges by UID:

  - appendFullUID: like appendFull, returns the APPENDUID response code
  - copyUID / copyUIDs / copyUIDR: UID COPY returning the COPYUID code
  - uidExpunge / uidExpungeR: UID EXPUNGE over a UID set or range

New types AppendUID and CopyUID, the UIDSet alias, and the
APPENDUID/COPYUID/UIDNOTSTICKY status codes with their parsers.
sendCommandWithResponse exposes the tagged ServerResponse so the
response codes can be read. The existing appendFull/copyFull keep their
old signatures by discarding the UID result.

Covered by new parser cases in baseTest and a dedicated imapUIDPlusTest
group exercising the API against scripted server responses.
RFC 3501 keywords, response codes, flag names and status attributes are
case-insensitive, but the parser matched them with case-sensitive
`string`, so any server replying with non-canonical casing (e.g. `ok`,
`* search`, `[uidvalidity ...]`, `\seen`) caused a parse error.

Adds `stringCI`/`charCI` and applies them throughout the response
parser. Along the way the tagged/fatal response handling is factored
into `pWithTaggedOrFatal`, `pDone` is split into
`pRespCode`/`pRespText`/`pStatusCode`, and string parsing is unified
(`pQuotedString`/`pLiteralString`/`pAString`/`pMailboxName`). This also:

  - surfaces an untagged `* BYE` as a fatal response instead of failing
  - accepts an empty `* SEARCH` reply (no matches)
  - accepts a `NIL` hierarchy separator in LIST/LSUB
  - stops `atomChar` from running past CR/LF

Covered by a new caseInsensitiveTest group.
IMAP SEARCH string keys (BCC/BODY/CC/FROM/HEADER/SUBJECT/TEXT/TO/
X-GM-RAW) were interpolated unquoted, so any value containing a space
or special character produced a malformed command. They are now wrapped
with quoteIMAPString.

LARGER/SMALLER wrongly wrapped their octet count in `{}` (the literal
syntax), e.g. `LARGER {100}`; the size is a plain number (`LARGER 100`).

SEARCH now auto-detects non-ASCII text in a query and prepends
`CHARSET UTF-8`, and command bytes are sent UTF-8 encoded
(sendCommandNoResponse) so the non-ASCII bytes survive instead of being
truncated to Latin-1.

Covered by a new imapSearchApiTest group.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant